home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.n / error.n < prev    next >
Text File  |  1995-07-25  |  4KB  |  66 lines
  1.  
  2.  
  3.  
  4.      eeeerrrrrrrroooorrrr((((nnnn))))                     TTTTccccllll (((( ))))                     eeeerrrrrrrroooorrrr((((nnnn))))
  5.  
  6.  
  7.  
  8.      _________________________________________________________________
  9.  
  10.      NNNNAAAAMMMMEEEE
  11.           error - Generate an error
  12.  
  13.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.           eeeerrrrrrrroooorrrr _m_e_s_s_a_g_e ?_i_n_f_o? ?_c_o_d_e?
  15.      _________________________________________________________________
  16.  
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           Returns   a   TCL_ERROR   code,   which    causes    command
  20.           interpretation  to  be unwound.  _M_e_s_s_a_g_e is a string that is
  21.           returned to the application to indicate what went wrong.
  22.  
  23.           If the _i_n_f_o argument is provided and  is  non-empty,  it  is
  24.           used to initialize the global variable eeeerrrrrrrroooorrrrIIIInnnnffffoooo.  eeeerrrrrrrroooorrrrIIIInnnnffffoooo
  25.           is used to accumulate a stack trace of what was in  progress
  26.           when  an  error occurred; as nested commands unwind, the Tcl
  27.           interpreter adds information  to  eeeerrrrrrrroooorrrrIIIInnnnffffoooo.   If  the  _i_n_f_o
  28.           argument  is present, it is used to initialize eeeerrrrrrrroooorrrrIIIInnnnffffoooo and
  29.           the first increment of unwind information will not be  added
  30.           by  the  Tcl  interpreter.   In  other  words,  the  command
  31.           containing the eeeerrrrrrrroooorrrr command will not appear  in  eeeerrrrrrrroooorrrrIIIInnnnffffoooo;
  32.           in  its  place will be _i_n_f_o.  This feature is most useful in
  33.           conjunction with the ccccaaaattttcccchhhh command: if a caught error cannot
  34.           be  handled successfully, _i_n_f_o can be used to return a stack
  35.           trace reflecting the original point  of  occurrence  of  the
  36.           error:
  37.  
  38.                ccccaaaattttcccchhhh {{{{............}}}} eeeerrrrrrrrMMMMssssgggg
  39.                sssseeeetttt ssssaaaavvvveeeeddddIIIInnnnffffoooo $$$$eeeerrrrrrrroooorrrrIIIInnnnffffoooo
  40.                ............
  41.                eeeerrrrrrrroooorrrr $$$$eeeerrrrrrrrMMMMssssgggg $$$$ssssaaaavvvveeeeddddIIIInnnnffffoooo
  43.           If the _c_o_d_e argument is present, then its value is stored in
  44.           the eeeerrrrrrrroooorrrrCCCCooooddddeeee global variable.  This variable is intended to
  45.           hold a machine-readable description of the  error  in  cases
  46.           where  such information is available; see the section BUILT-
  47.           IN VARIABLES below for information on the proper format  for
  48.           the  variable.   If  the  _c_o_d_e argument is not present, then
  49.           eeeerrrrrrrroooorrrrCCCCooooddddeeee is automatically reset  to  ``NONE''  by  the  Tcl
  50.           interpreter as part of processing the error generated by the
  51.           command.
  52.  
  53.  
  54.      KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  55.           error, errorCode, errorInfo
  56.  
  57.  
  58.  
  60.  
  61.  
  62.      Page 1                                          (printed 7/17/95)
  63.  
  64.  
  65.  
  66.